Resource OperationDefinition/FHIR Server from package medicalert.fhir.ig.firstresponder#current (62 ms)

Resources that use this resource

CapabilityStatement
MedicAlert-FirstResponderAPI	MedicAlert IPS Server Capability Statement

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "MedicAlertSummary",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition MedicAlertSummary</b></p><a name=\"MedicAlertSummary\"> </a><a name=\"hcMedicAlertSummary\"> </a><a name=\"MedicAlertSummary-en-NZ\"> </a><p>URL: [base]/Patient/$summary</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>identifer</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>Either the MedicAlert Member ID, valid NHI number, or valed accessKey must be provided. This should be provided as the identifier system URI followed by the id, seperated by a pipe character</p>\n</div></td></tr><tr><td>IN</td><td>reason</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td><a href=\"ValueSet-access-reason-vs.html\">MedicAlert Access Reason ValueSet</a> (Required)</td><td><div><p>The reason/context that the service is accessed for</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The Bundle returned is a patient summary conforming to the <a href=\"https://standards.medicalert.nz/MedicAlertPatientSummaryBundle\">MedicAlert Patient Summary bundle</a> (if not otherwise specified)</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://standards.medicalert.nz/ns/MedicAlertSummary",
  "version" : "0.1.0",
  "name" : "MedicAlertPatientSummary",
  "title" : "MedicAlert Patient Summary",
  "status" : "draft",
  "kind" : "query",
  "date" : "2022-11-08T13:15:56.964-00:00",
  "publisher" : "MedicAlert",
  "contact" : [
    {
      "name" : "MedicAlert",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://medicalert.nz/"
        }
      ]
    }
  ],
  "description" : "The MedicAlert first responder API is queried using a FHIR operation. This is the $summary operation invoked on the Patient resource. The $summary operation returns a set of resources, organized as a Bundle. \n\nThe response Bundle is structured as a FHIR document that is based on the [IPS standard](https://hl7.org/fhir/uv/ips/). \n\nAn identifier for the patient (MedicAlert ID or NHI number) must be provided along with a reason for the API access. \n\n### Querying the API\n\nThe $summary operation must be invoked as a POST with the parameters passed in the message body.\n\nAn example query for emergency access using an NHI number:\n```\nPOST [base]/Patient/$summary\nContent-Type: application/x-www-form-urlencoded\n\n_identifier=https://standards.digital.health.nz/ns/nhi%7CZZZ0016&reason=EmergencyAccess\n```\nAn example query for non emergency access using the MedicAlert id:\n```\nPOST [base]/Patient/$summary\nContent-Type: application/x-www-form-urlencoded\n\n_identifier=https://standards.medicalert.nz/memberId%7C1001&reason=NonEmergencyAccess\n```\nAn example query for emergency access using an accessKey:\n```\nPOST [base]/Patient/$summary\nContent-Type: application/x-www-form-urlencoded\n\n_identifier=https://standards.medicalert.nz/accessKey%7C10011XX1&reason=EmergencyAccess\n```\n\n\n(note that non-standard ASCII characters such as the | character must be URL encoded - in this case as %7C)",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "NZ",
          "display" : "New Zealand"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "summary",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "identifer",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Either the MedicAlert Member ID, valid NHI number, or valed accessKey must be provided. This should be provided as the identifier system URI followed by the id, seperated by a pipe character",
      "type" : "Identifier"
    },
    {
      "name" : "reason",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The reason/context that the service is accessed for",
      "type" : "Coding",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://standards.medicalert.nz/ValueSet/AccessReason"
      }
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "The Bundle returned is a patient summary conforming to the [MedicAlert Patient Summary bundle](https://standards.medicalert.nz/MedicAlertPatientSummaryBundle) (if not otherwise specified)",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.